Get Jobs
Imagine having a long list of transcription jobs and needing to find just the right ones—whether they're complete, in progress, or need filtering by language. The Get Jobs API endpoint is like sifting through a warehouse of tasks, allowing you to filter by status, language, and even paginate through the results. Efficiency at its best!
Endpoint
https://api.betatel.com/api/v1/stt/job/job?status=completed&language=en&offset=0&limit=5
Tweak the query parameters to narrow down your search for jobs. Adjust status
, language
, offset
, and limit
to get the perfect batch of results.
Parameter | Value | Type | Required | Description |
---|---|---|---|---|
status | completed | string | No | Filter jobs by their status (e.g., processing , completed ). |
language | en | string | No | Retrieve jobs filtered by language (e.g., en , es ). |
offset | 0 | int | No | The starting point for pagination. |
limit | 5 | int | No | The maximum number of jobs to return. |
Headers
Essential keys to unlock the data:
Param | Value | Description |
---|---|---|
x-api-key | {{x-api-key}} | Your unique API key for secure access. |
x-user-id | {{x-user-id}} | Your user identifier for added security and tracking. |
Code Snippets
Use any of the following code snippets to fetch your filtered jobs in your preferred programming language:
- cUrl
- Python
- Node.js
- PHP
- Java
- C#
curl --location 'https://dev.api.betatel.com/api/v1/stt/job?status=completed&language=en&offset=0&limit=5' \
--header 'x-user-id: 6757f3ffb5e62f0ce0e513a2' \
--header 'x-api-key: ••••••'
import http.client
conn = http.client.HTTPSConnection("dev.api.betatel.com")
payload = ''
headers = {
'x-user-id': '6757f3ffb5e62f0ce0e513a2',
'x-api-key': '••••••'
}
conn.request("GET", "/api/v1/stt/job?status=completed&language=en&offset=0&limit=5", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: 'https://dev.api.betatel.com/api/v1/stt/job?status=completed&language=en&offset=0&limit=5',
headers: {
'x-user-id': '6757f3ffb5e62f0ce0e513a2',
'x-api-key': '••••••'
}
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://dev.api.betatel.com/api/v1/stt/job?status=completed&language=en&offset=0&limit=5',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'x-user-id: 6757f3ffb5e62f0ce0e513a2',
'x-api-key: ••••••'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://dev.api.betatel.com/api/v1/stt/job?status=completed&language=en&offset=0&limit=5")
.header("x-user-id", "6757f3ffb5e62f0ce0e513a2")
.header("x-api-key", "••••••")
.asString();
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://dev.api.betatel.com/api/v1/stt/job?status=completed&language=en&offset=0&limit=5");
request.Headers.Add("x-user-id", "6757f3ffb5e62f0ce0e513a2");
request.Headers.Add("x-api-key", "••••••");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Response
A confirmation message will be returned, indicating the successful retrieval of the selected jobs.
🎉 Congratulations
You're now equipped to filter through jobs and retrieve exactly what you need. With this API endpoint, managing transcription projects has never been easier. Happy filtering!